home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / Reference / DevCon / Atlanta_1990 / Atlanta-Devcon.2 / AppShell / examples / WatchMan / fn_handler.doc < prev    next >
Encoding:
Text File  |  1992-08-26  |  1.6 KB  |  69 lines

  1. TABLE OF CONTENTS
  2.  
  3. fn_handler/FileNotify
  4. fn_handler/NOTIFY
  5. fn_handler/FileNotify                                   fn_handler/FileNotify
  6.  
  7.    NAME
  8.     FileNotify - Send command to fn_handler
  9.  
  10.    SYNOPSIS
  11.     FileNotify(struct AppInfo * ai, STRPTR str, ULONG tags,...)
  12.  
  13.     struct AppInfo *ai;
  14.     STRPTR str;
  15.     ULONG tags,...
  16.  
  17.    FUNCTION
  18.     This function lets the application send commands to the fn_handler.
  19.  
  20.    EXAMPLE
  21.     FileNotify(ai, NULL,
  22.         FN_Command, FN_INQUIRY,
  23.         FN_Filename, "dh0:testfile"
  24.         FN_Error, &error,
  25.         FN_Buffer, fndata,
  26.         TAG_DONE);
  27.  
  28.    INPUTS
  29.     ai    - pointer to the AppInfo structure for this application.
  30.     str    - pointer to a command line like string or NULL
  31.     tags    - stack based TagItems.
  32.  
  33.  
  34.    RESULT
  35.     Error values are returned in ai->Pri_Err and ai->Sec_Err.
  36.     If requested, the primary error value is returned in an 
  37.     application supplied BOOL variable.
  38.     If requested, the data as used by the fn_handler is returned
  39.     in an application supplied FNData structure.
  40.  
  41.    SEE ALSO
  42.     NOTIFY / fn_handler.h
  43.  
  44. fn_handler/NOTIFY                                           fn_handler/NOTIFY
  45.  
  46.    NAME
  47.     NOTIFY - Send a command to the fn_handler
  48.  
  49.    SYNOPSIS
  50.     FNotifyID   <Command> <FILE=filename> [INT=interval]
  51.                     [RET=retries] [FLAGS=flags]
  52.  
  53.    FUNCTION
  54.     Allows command line commands to be directly send to the handler.
  55.     
  56.     Accepted commands: ADD, DEL, SYNC.
  57.     See fn_handler.h for valid flags.
  58.     If optional arguments are ommited, interval defaults to 60,
  59.     retries to -1, flags to FN_NEWER.
  60.  
  61.    EXAMPLE
  62.  
  63.     NOTIFY ADD FILE=topcat:mbox INT=20 RET=-1 FLAGS=FN_NEWER|FN_MUSTEXIST
  64.  
  65.  
  66.    SEE ALSO
  67.     FileNotify() / fn_handler.h
  68.  
  69.